Skip to content

Add option to skip removed URLs check#532

Open
jugmac00 wants to merge 1 commit intocanonical:mainfrom
jugmac00:make-url-checks-skippable
Open

Add option to skip removed URLs check#532
jugmac00 wants to merge 1 commit intocanonical:mainfrom
jugmac00:make-url-checks-skippable

Conversation

@jugmac00
Copy link
Copy Markdown
Member

Allow users to skip the removed URLs check by including 'skip removed-urls-check' in the PR title, PR body, or commit message. This is useful when intentionally removing pages or when redirects will be added in a follow-up commit.

Added a how-to guide explaining how to use this feature with an example commit message.

Fixes #531

  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

Allow users to skip the removed URLs check by including
'skip removed-urls-check' in the PR title, PR body, or commit message.
This is useful when intentionally removing pages or when redirects
will be added in a follow-up commit.

Added a how-to guide explaining how to use this feature with
an example commit message.

Fixes canonical#531
if: |
!contains(github.event.pull_request.title, 'skip check-removed-urls') &&
!contains(github.event.pull_request.body, 'skip check-removed-urls') &&
!contains(github.event.head_commit.message, 'skip check-removed-urls')
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be better to just use the PR title and body, as this action only runs in a PR - and it will only read from the head commit to skip the action.

Copy link
Copy Markdown
Collaborator

@SecondSkoll SecondSkoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clever. I do see this as something that would be valuable - to the point where we should probably (eventually) move this to documentation-workflows and set it up as a remote action so adopters can stay up to date with nice features like this.

I've left a comment, but I don't think it's blocking. However, I'll get some more input from the TA team before approving.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

check-removed-urls.yml is too strict

2 participants